fix(docs): fix documentation errors in docs#165
Open
Peopl3s wants to merge 1 commit into
Open
Conversation
LilyFirefly
reviewed
May 24, 2026
Collaborator
LilyFirefly
left a comment
LilyFirefly
left a comment
There was a problem hiding this comment.
Thanks for this! Once we've decided how to handle part_of_a_transaction, I'm happy for this to be merged!
| If you're testing [`transaction_required`][django_subatomic.db.transaction_required] code directly, | ||
| and you're _sure_ that the code shouldn't be responsible for opening a transaction, | ||
| use the [`part_of_a_transaction`][django_subatomic.test.part_of_a_transaction] decorator/context-manager | ||
| use the [`part_of_a_transaction`][django_subatomic.test.part_of_a_transaction] context manager |
Collaborator
There was a problem hiding this comment.
part_of_a_transaction can actually be used as a decorator, since it is defined using contextlib.contextmanager.
That said, I wonder if it would make sense to restrict this down to just a context manager, like we do with savepoint?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #164